<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>netLink C++ 11: include/ContainerHeader.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">netLink C++ 11
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">ContainerHeader.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">    netLink: c++ 11 networking library</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">    Copyright (C) 2013-2023 Alexander Meißner</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">    This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">    it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">    the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">    (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">    This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">    GNU General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">    You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;Header.h&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">namespace </span>MsgPack {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_msg_pack_1_1_array_header.html">   26</a></span>    <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_array_header.html">ArrayHeader</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_msg_pack_1_1_header.html">Header</a> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>        <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_serializer.html">Serializer</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>        <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_deserializer.html">Deserializer</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>        <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>        <a class="code hl_class" href="class_msg_pack_1_1_array_header.html">ArrayHeader</a>() { }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>        int64_t <a class="code hl_function" href="class_msg_pack_1_1_array_header.html#ad8c0986baa43a959cc1b19f91081f74c">getHeaderLength</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>        <span class="keyword">public</span>:</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>        <a class="code hl_class" href="class_msg_pack_1_1_array_header.html">ArrayHeader</a>(uint32_t len);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>        std::unique_ptr&lt;Element&gt; <a class="code hl_function" href="class_msg_pack_1_1_array_header.html#a1eb167f38cb472f1613212a8f0f23cd5">copy</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>        <span class="keywordtype">void</span> <a class="code hl_function" href="class_msg_pack_1_1_array_header.html#af5116f10cca7a65d4aae0e4a768f2079">toJSON</a>(std::ostream&amp; stream) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>        uint32_t <a class="code hl_function" href="class_msg_pack_1_1_array_header.html#ae093628601fdb46f3463e1daa7311e45">getSizeInBytes</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>        uint32_t <a class="code hl_function" href="class_msg_pack_1_1_array_header.html#a8f0430cec636adecf15f81921598975b">getLength</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>    };</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_msg_pack_1_1_map_header.html">   43</a></span>    <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_map_header.html">MapHeader</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_msg_pack_1_1_header.html">Header</a> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>        <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_serializer.html">Serializer</a>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>        <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_deserializer.html">Deserializer</a>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>        <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>        <a class="code hl_class" href="class_msg_pack_1_1_map_header.html">MapHeader</a>() { }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>        int64_t <a class="code hl_function" href="class_msg_pack_1_1_map_header.html#aec44d3bfe7e64ef9e8ec8ce8d988c470">getHeaderLength</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>        <span class="keyword">public</span>:</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>        <a class="code hl_class" href="class_msg_pack_1_1_map_header.html">MapHeader</a>(uint32_t len);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>        std::unique_ptr&lt;Element&gt; <a class="code hl_function" href="class_msg_pack_1_1_map_header.html#abf3e7fe6ea4e29eb7ee6c66f87bc8c55">copy</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>        <span class="keywordtype">void</span> <a class="code hl_function" href="class_msg_pack_1_1_map_header.html#a462403ed9f65e13d5fa7ec7d640485a7">toJSON</a>(std::ostream&amp; stream) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>        uint32_t <a class="code hl_function" href="class_msg_pack_1_1_map_header.html#a002104dfa073a6a011332d7dc41c4f9d">getSizeInBytes</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>        uint32_t <a class="code hl_function" href="class_msg_pack_1_1_map_header.html#a3c6b65193bd7e9e9a32fea2847e41064">getLength</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    };</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>};</div>
<div class="ttc" id="aclass_msg_pack_1_1_array_header_html"><div class="ttname"><a href="class_msg_pack_1_1_array_header.html">MsgPack::ArrayHeader</a></div><div class="ttdoc">MsgPack::Header representing only the header of a array.</div><div class="ttdef"><b>Definition</b> ContainerHeader.h:26</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_array_header_html_a1eb167f38cb472f1613212a8f0f23cd5"><div class="ttname"><a href="class_msg_pack_1_1_array_header.html#a1eb167f38cb472f1613212a8f0f23cd5">MsgPack::ArrayHeader::copy</a></div><div class="ttdeci">std::unique_ptr&lt; Element &gt; copy() const</div><div class="ttdoc">Creates a deep copy of this element.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:758</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_array_header_html_a8f0430cec636adecf15f81921598975b"><div class="ttname"><a href="class_msg_pack_1_1_array_header.html#a8f0430cec636adecf15f81921598975b">MsgPack::ArrayHeader::getLength</a></div><div class="ttdeci">uint32_t getLength() const</div><div class="ttdoc">Returns the count of elements in the container.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:743</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_array_header_html_ad8c0986baa43a959cc1b19f91081f74c"><div class="ttname"><a href="class_msg_pack_1_1_array_header.html#ad8c0986baa43a959cc1b19f91081f74c">MsgPack::ArrayHeader::getHeaderLength</a></div><div class="ttdeci">int64_t getHeaderLength() const</div><div class="ttdoc">Returns the size of the header in bytes.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:770</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_array_header_html_ae093628601fdb46f3463e1daa7311e45"><div class="ttname"><a href="class_msg_pack_1_1_array_header.html#ae093628601fdb46f3463e1daa7311e45">MsgPack::ArrayHeader::getSizeInBytes</a></div><div class="ttdeci">uint32_t getSizeInBytes() const</div><div class="ttdoc">Returns the size in bytes this MsgPack::Element takes if completely serialized.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:766</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_array_header_html_af5116f10cca7a65d4aae0e4a768f2079"><div class="ttname"><a href="class_msg_pack_1_1_array_header.html#af5116f10cca7a65d4aae0e4a768f2079">MsgPack::ArrayHeader::toJSON</a></div><div class="ttdeci">void toJSON(std::ostream &amp;stream) const</div><div class="ttdoc">Writes a human readable JSON-like string into the given stream.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:762</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_deserializer_html"><div class="ttname"><a href="class_msg_pack_1_1_deserializer.html">MsgPack::Deserializer</a></div><div class="ttdoc">Used to deserialize elements from a std::streambuf.</div><div class="ttdef"><b>Definition</b> StreamManager.h:71</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html"><div class="ttname"><a href="class_msg_pack_1_1_header.html">MsgPack::Header</a></div><div class="ttdoc">MsgPack::Element to represent the header of a dynamical length element.</div><div class="ttdef"><b>Definition</b> Header.h:26</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_map_header_html"><div class="ttname"><a href="class_msg_pack_1_1_map_header.html">MsgPack::MapHeader</a></div><div class="ttdoc">MsgPack::Header representing only the header of a map.</div><div class="ttdef"><b>Definition</b> ContainerHeader.h:43</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_map_header_html_a002104dfa073a6a011332d7dc41c4f9d"><div class="ttname"><a href="class_msg_pack_1_1_map_header.html#a002104dfa073a6a011332d7dc41c4f9d">MsgPack::MapHeader::getSizeInBytes</a></div><div class="ttdeci">uint32_t getSizeInBytes() const</div><div class="ttdoc">Returns the size in bytes this MsgPack::Element takes if completely serialized.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:822</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_map_header_html_a3c6b65193bd7e9e9a32fea2847e41064"><div class="ttname"><a href="class_msg_pack_1_1_map_header.html#a3c6b65193bd7e9e9a32fea2847e41064">MsgPack::MapHeader::getLength</a></div><div class="ttdeci">uint32_t getLength() const</div><div class="ttdoc">Returns the count of elements in the container.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:826</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_map_header_html_a462403ed9f65e13d5fa7ec7d640485a7"><div class="ttname"><a href="class_msg_pack_1_1_map_header.html#a462403ed9f65e13d5fa7ec7d640485a7">MsgPack::MapHeader::toJSON</a></div><div class="ttdeci">void toJSON(std::ostream &amp;stream) const</div><div class="ttdoc">Writes a human readable JSON-like string into the given stream.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:818</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_map_header_html_abf3e7fe6ea4e29eb7ee6c66f87bc8c55"><div class="ttname"><a href="class_msg_pack_1_1_map_header.html#abf3e7fe6ea4e29eb7ee6c66f87bc8c55">MsgPack::MapHeader::copy</a></div><div class="ttdeci">std::unique_ptr&lt; Element &gt; copy() const</div><div class="ttdoc">Creates a deep copy of this element.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:814</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_map_header_html_aec44d3bfe7e64ef9e8ec8ce8d988c470"><div class="ttname"><a href="class_msg_pack_1_1_map_header.html#aec44d3bfe7e64ef9e8ec8ce8d988c470">MsgPack::MapHeader::getHeaderLength</a></div><div class="ttdeci">int64_t getHeaderLength() const</div><div class="ttdoc">Returns the size of the header in bytes.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:799</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_serializer_html"><div class="ttname"><a href="class_msg_pack_1_1_serializer.html">MsgPack::Serializer</a></div><div class="ttdoc">Used to serialize elements into a std::streambuf.</div><div class="ttdef"><b>Definition</b> StreamManager.h:37</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
